API

Base APIs

GET base/formula-definitions/{formulaDefinitionId}

Get details for the given formula definition

HTTP method GET
URI https://api.rambase.net/base/formula-definitions/{formulaDefinitionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {formulaDefinitionId} Formula identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2493, version 3

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<FormulaDefinition>
2
     <FormulaDefinitionId
FormulaDefinitionId

Formula identifier

>{Integer}</FormulaDefinitionId>
3
     <Status
Status

Status of the formula

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Title
Title

Title of the formula

>{String}</Title>
6
     <TranslatedTitle
TranslatedTitle

Title translated to selected language. If no translation exists, the english title will show

>{String}</TranslatedTitle>
7
     <Description
Description

Description of the formula

>{String}</Description>
8
     <TranslatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists, the english description will show

>{String}</TranslatedDescription>
9
     <Formula
Formula

The formula may include numeric values, parenthesized expressions, parameters, and mathematical operators. The following operators are supported: + - * /.

>{String}</Formula>
10
     <Type
Type

Type of formula

Possible domain values can be found here

>{String}</Type>
11
     <Repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
12
          <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{String}</Scope>
13
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsChanged>
14
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
15
               <UserId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Integer}</UserId>
16
               <UserLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{String}</UserLink>
17
          </ChangedBy>
18
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsPendingDeployment>
19
     </Repository>
20
</FormulaDefinition>
1
{
2
     "formulaDefinition": {
3
          "formulaDefinitionId
FormulaDefinitionId

Formula identifier

": "{Integer}",
4
          "status
Status

Status of the formula

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "title
Title

Title of the formula

": "{String}",
7
          "translatedTitle
TranslatedTitle

Title translated to selected language. If no translation exists, the english title will show

": "{String}",
8
          "description
Description

Description of the formula

": "{String}",
9
          "translatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists, the english description will show

": "{String}",
10
          "formula
Formula

The formula may include numeric values, parenthesized expressions, parameters, and mathematical operators. The following operators are supported: + - * /.

": "{String}",
11
          "type
Type

Type of formula

Possible domain values can be found here

": "{String}",
12
          "repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
13
               "scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{String}",
14
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}",
15
               "changedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
16
                    "userId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Integer}",
17
                    "userLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{String}"
18
               },
19
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}"
20
          }
21
     }
22
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found